Boleto Bancário pago Webhook

info

📘 Para saber mais sobre webhooks em nossa API, siga o link abaixo:

Sobre Webhooks

Quando um pagamento de cobrança de boleto bancário é creditado em sua conta, a melhor maneira de receber essas informações é usando o webhook CHARGE_PAID. Assim que um pagamento de boleto bancário é recebido em sua conta, um webhook CHARGE_PAID é enviado.

Esta é a maneira mais simples de configurar um webhook CHARGE_PAID:

Headers

Nome	Descrição
x-delbank-api-key	Obrigatório. Chave de API

Corpo da requisição

{
  "eventType": "CHARGE_PAID",
  "url": "https://example.com.br/webhooks/v1/chargepaid", // Add your own URL here
  "authorization": "NONE,
  "authorizationScheme": "NONE"
}

Asim que o boleto bancário é pago e creditado na sua conta, aqui está o que você receberá no URL registrado:

CHARGE_PAID

{
   "eventType":"CHARGE_PAID_V2",
   "correlationId":"a0443e00-a74f-4151-8022-6ad4256bfb66",
   "walletNumber":"112",
   "yourNumber":"200806081444",
   "ourNumber":"00001050733",
   "amount":20.00,
   "dueDate":"2025-01-28T00:00:00",
   "barCode":"43597997500000020000001112000082100001050733",
   "digitableLine":"43590001161200008210200010507333799750000002000",
   "payer":{
      "name":"TEST PAYER",
      "document":"11111111111",
      "zipCode":"12345678",
      "address":"ADDRESS TEST",
      "neighborhood":"NEIGHBORHOOD",
      "city":"SÃO PAULO",
      "state":"SP",
      "email":"[email protected]"
   },
   "createdAt":"2025-01-28T19:44:15.913Z",
   "status":"PAID",
   "payments":[
      {
         "date":"2025-01-28T03:00:00.000Z",
         "amount":20.00,
         "payer":{
            "name":"TEST PAYER",
            "document":"11111111111"
         },
         "issuer":{
            "code":"0633",
            "ispb":"68900810",
            "branch":"0001",
            "name":"BANCO RENDIMENTO S.A.",
            "fantasyName":"BCO RENDIMENTO S.A."
         }
      }
   ]
}

Aqui está outro exemplo

{
   "eventType":"CHARGE_PAID_V2",
   "correlationId":"a0443e00-a74f-4151-8022-6ad4256bfb66",
   "walletNumber":"112",
   "yourNumber":"200806081444",
   "ourNumber":"00001050733",
   "amount":20.00,
   "dueDate":"2025-01-28T00:00:00",
   "barCode":"43597997500000020000001112000082100001050733",
   "digitableLine":"43590001161200008210200010507333799750000002000",
   "payer":{
      "name":"TEST PAYER",
      "document":"11111111111",
      "zipCode":"12345678",
      "address":"ADDRESS TEST",
      "neighborhood":"NEIGHBORHOOD",
      "city":"SÃO PAULO",
      "state":"SP",
      "email":"[email protected]"
   },
   "createdAt":"2025-01-28T19:44:15.913Z",
   "status":"PAID",
   "payments":[
      {
         "date":"2025-01-28T03:00:00.000Z",
         "amount":20.00,
         "payer":{
            "name":"TEST PAYER",
            "document":"11111111111"
         },
         "issuer":{
            "code":"0633",
            "ispb":"68900810",
            "branch":"0001",
            "name":"BANCO RENDIMENTO S.A.",
            "fantasyName":"BCO RENDIMENTO S.A."
         }
      }
   ]
}

Aqui estão os atributos que são passados ​​pelo webhook CHARGE_PAID:

Nome	Descrição
nsu	O identificador único para a transação (ex.: "513").
correlationId	Um identificador único usado para rastrear a transação (ex.: "217c34be-b374-4e33-9ae2-1b46f14b7116").
referenceId	O identificador de referência para a transação (ex.: "E3822485720230705211537850921369").
source	A origem da transação (ex.: "SPI").
amount	O valor monetário da transação (ex.: 12.12).
createdAt	O timestamp indicando quando a transação foi criada (ex.: "2023-07-05T17:52:33Z").
payer	Um objeto contendo informações sobre o pagador da transação.
payer.name	O nome do pagador (ex.: "FULANO DA SILVA").
payer.document	O número do documento do pagador (ex.: "12399999999").
proof	Um objeto contendo informações detalhadas da comprovação da transação.
proof.endToEndId	O identificador único da transação dentro do contexto da comprovação (ex.: "E3822485720230705211537850921369").
proof.transactionId	O identificador único da transação (ex.: "chargeCqkFlaENmal5NrPK58J").
proof.key	Uma chave única para a comprovação (ex.: "5b0ac9a4-fad6-43f9-be70-6d7c9a2fad26").
proof.amount	O valor monetário da transação dentro do contexto da comprovação (ex.: 12.12).
proof.payer	Um objeto contendo informações sobre o pagador da transação.
proof.payer.number	O número da conta do pagador (ex.: "10065").
proof.payer.branch	O número da agência da conta do pagador (ex.: "0001").
proof.payer.type	O tipo da conta do pagador (ex.: "CURRENT").
proof.payer.holder	Um objeto contendo informações sobre o titular da conta do pagador.
proof.payer.holder.name	O nome do pagador (ex.: "FULANO DA SILVA").
proof.payer.holder.document	O número do documento do pagador (ex.: "02599999908").
proof.payer.participant	Um objeto contendo informações sobre a instituição financeira do pagador.
proof.payer.participant.ispb	O código ISPB da instituição financeira do pagador (ex.: "38224857").
proof.payer.participant.name	O nome da instituição financeira do pagador (ex.: "DELCRED SCD S.A.").
proof.payee	Um objeto contendo informações sobre o recebedor da transação.
proof.payee.number	O número da conta do recebedor (ex.: "29823").
proof.payee.branch	O número da agência da conta do recebedor (ex.: "0001").
proof.payee.type	O tipo da conta do recebedor (ex.: "CURRENT").
proof.payee.holder	Um objeto contendo informações sobre o titular da conta do recebedor.
proof.payee.holder.name	O nome do recebedor (ex.: "HOMOLOGACAO INTEGRACAO API").
proof.payee.holder.document	O número do documento do recebedor (ex.: "30287697789").
proof.payee.participant	Um objeto contendo informações sobre a instituição financeira do recebedor.
proof.payee.participant.ispb	O código ISPB da instituição financeira do recebedor (ex.: "38224857").
proof.payee.participant.name	O nome da instituição financeira do recebedor (ex.: "DELCRED SCD S.A.").